home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / srcuc.zip / BCHPUR.C < prev    next >
C/C++ Source or Header  |  1992-06-03  |  16KB  |  569 lines
  1. /* -*-C-*-
  2.  
  3. $Header: /scheme/src/microcode/RCS/bchpur.c,v 9.58 1992/06/03 21:54:53 jinx Exp $
  4.  
  5. Copyright (c) 1987-1992 Massachusetts Institute of Technology
  6.  
  7. This material was developed by the Scheme project at the Massachusetts
  8. Institute of Technology, Department of Electrical Engineering and
  9. Computer Science.  Permission to copy this software, to redistribute
  10. it, and to use it for any purpose is granted, subject to the following
  11. restrictions and understandings.
  12.  
  13. 1. Any copy made of this software must include this copyright notice
  14. in full.
  15.  
  16. 2. Users of this software agree to make their best efforts (a) to
  17. return to the MIT Scheme project any improvements or extensions that
  18. they make, so that these may be included in future releases; and (b)
  19. to inform MIT of noteworthy uses of this software.
  20.  
  21. 3. All materials developed as a consequence of the use of this
  22. software shall duly acknowledge such use, in accordance with the usual
  23. standards of acknowledging credit in academic research.
  24.  
  25. 4. MIT has made no warrantee or representation that the operation of
  26. this software will be error-free, and MIT is under no obligation to
  27. provide any services, by way of maintenance, update, or otherwise.
  28.  
  29. 5. In conjunction with products arising from the use of this material,
  30. there shall be no use of the name of the Massachusetts Institute of
  31. Technology nor of any adaptation thereof in any advertising,
  32. promotional, or sales literature without prior written consent from
  33. MIT in each case. */
  34.  
  35. /*
  36.  * This file contains the code for primitives dealing with pure
  37.  * and constant space.  Garbage collection to disk version.
  38.  *
  39.  * Poorly implemented:  If there is not enough space, instead of
  40.  * undoing the changes, it crashes.
  41.  * It should be changed to do the job in two passes like the
  42.  * "normal" version.
  43.  */
  44.  
  45. #include "scheme.h"
  46. #include "prims.h"
  47. #include "bchgcc.h"
  48. #include "zones.h"
  49.  
  50. /* Purify modes */
  51.  
  52. #define    NORMAL_GC    0
  53. #define PURE_COPY    1
  54. #define CONSTANT_COPY    2
  55.  
  56. /* Some utility macros. */
  57.  
  58. #define relocate_indirect_setup()                    \
  59. {                                    \
  60.   Old = OBJECT_ADDRESS (Temp);                        \
  61.   if (Old >= Low_Constant)                        \
  62.     continue;                                \
  63.   if (OBJECT_TYPE (*Old) == TC_BROKEN_HEART)                \
  64.   {                                    \
  65.     continue;                                \
  66.   }                                    \
  67.   New_Address = (MAKE_BROKEN_HEART (To_Address));            \
  68. }
  69.  
  70. #define relocate_indirect_end()                        \
  71. {                                    \
  72.   *OBJECT_ADDRESS (Temp) = New_Address;                    \
  73.   continue;                                \
  74. }
  75.  
  76. /* A modified copy of GCLoop. */
  77.  
  78. static SCHEME_OBJECT *
  79. DEFUN (purifyloop, (Scan, To_ptr, To_Address_ptr, purify_mode),
  80.        fast SCHEME_OBJECT *Scan AND
  81.        SCHEME_OBJECT **To_ptr AND
  82.        SCHEME_OBJECT **To_Address_ptr AND
  83.        int purify_mode)
  84. {
  85.   fast SCHEME_OBJECT *To, *Old, Temp, *Low_Constant, *To_Address, New_Address;
  86.  
  87.   To = *To_ptr;
  88.   To_Address = *To_Address_ptr;
  89.   Low_Constant = Constant_Space;
  90.  
  91.   for ( ; Scan != To; Scan++)
  92.   {
  93.     Temp = *Scan;
  94.     Switch_by_GC_Type (Temp)
  95.     {
  96.       case TC_BROKEN_HEART:
  97.         if (Temp != (MAKE_POINTER_OBJECT (TC_BROKEN_HEART, Scan)))
  98.     {
  99.       sprintf (gc_death_message_buffer,
  100.            "purifyloop: broken heart (0x%lx) in scan",
  101.            Temp);
  102.       gc_death (TERM_BROKEN_HEART,
  103.             gc_death_message_buffer,
  104.             Scan, To);
  105.       /*NOTREACHED*/
  106.     }
  107.     if (Scan != scan_buffer_top)
  108.       goto end_purifyloop;
  109.     /* The -1 is here because of the Scan++ in the for header. */
  110.     Scan = ((dump_and_reload_scan_buffer (0, NULL)) - 1);
  111.     continue;
  112.  
  113.       case TC_MANIFEST_NM_VECTOR:
  114.       case TC_MANIFEST_SPECIAL_NM_VECTOR:
  115.     /* Check whether this bumps over current buffer,
  116.        and if so we need a new bufferfull. */
  117.     Scan += (OBJECT_DATUM (Temp));
  118.     if (Scan < scan_buffer_top)
  119.     {
  120.       break;
  121.     }
  122.     else
  123.     {
  124.       unsigned long overflow;
  125.  
  126.       /* The + & -1 are here because of the Scan++ in the for header. */
  127.       overflow = ((Scan - scan_buffer_top) + 1);
  128.       Scan = ((dump_and_reload_scan_buffer
  129.            ((overflow >> gc_buffer_shift), NULL)
  130.            + (overflow & gc_buffer_mask)) - 1);
  131.       break;
  132.     }
  133.  
  134.       case_compiled_entry_point:
  135.     if (purify_mode == PURE_COPY)
  136.       break;
  137.     relocate_compiled_entry (false);
  138.     *Scan = Temp;
  139.     break;
  140.  
  141.       case TC_LINKAGE_SECTION:
  142.       {
  143.     if (purify_mode == PURE_COPY)
  144.     {
  145.       gc_death (TERM_COMPILER_DEATH,
  146.             "purifyloop: linkage section in pure area",
  147.             Scan, To);
  148.       /*NOTREACHED*/
  149.     }
  150.     switch (READ_LINKAGE_KIND (Temp))
  151.     {
  152.       case REFERENCE_LINKAGE_KIND:
  153.       case ASSIGNMENT_LINKAGE_KIND:
  154.       {
  155.         /* count typeless pointers to quads follow. */
  156.  
  157.         fast long count;
  158.         long max_count, max_here;
  159.  
  160.         Scan++;
  161.         max_here = (scan_buffer_top - Scan);
  162.         max_count = (READ_CACHE_LINKAGE_COUNT (Temp));
  163.         while (max_count != 0)
  164.         {
  165.           count = ((max_count > max_here) ? max_here : max_count);
  166.           max_count -= count;
  167.           for ( ; --count >= 0; Scan += 1)
  168.           {
  169.         Temp = *Scan;
  170.         relocate_typeless_pointer (copy_quadruple(), 4);
  171.           }
  172.           if (max_count != 0)
  173.           {
  174.         /* We stopped because we needed to relocate too many. */
  175.         Scan = dump_and_reload_scan_buffer(0, NULL);
  176.         max_here = gc_buffer_size;
  177.           }
  178.         }
  179.         /* The + & -1 are here because of the Scan++ in the for header. */
  180.         Scan -= 1;
  181.         break;
  182.       }
  183.  
  184.       case OPERATOR_LINKAGE_KIND:
  185.       case GLOBAL_OPERATOR_LINKAGE_KIND:
  186.       {
  187.         /* Operator linkage */
  188.  
  189.         fast long count;
  190.         fast char *word_ptr, *next_ptr;
  191.         long overflow;
  192.  
  193.         word_ptr = (FIRST_OPERATOR_LINKAGE_ENTRY (Scan));
  194.         if (word_ptr > ((char *) scan_buffer_top))
  195.         {
  196.           overflow = (word_ptr - ((char *) Scan));
  197.           extend_scan_buffer (word_ptr, To);
  198.           BCH_START_OPERATOR_RELOCATION (Scan);
  199.           word_ptr = (end_scan_buffer_extension (word_ptr));
  200.           Scan = ((SCHEME_OBJECT *) (word_ptr - overflow));
  201.         }
  202.         else
  203.           BCH_START_OPERATOR_RELOCATION (Scan);
  204.         
  205.         count = (READ_OPERATOR_LINKAGE_COUNT (Temp));
  206.         overflow = ((END_OPERATOR_LINKAGE_AREA (Scan, count)) -
  207.             scan_buffer_top);
  208.  
  209.         for (next_ptr = (NEXT_LINKAGE_OPERATOR_ENTRY (word_ptr));
  210.          (--count >= 0);
  211.          word_ptr = next_ptr,
  212.          next_ptr = (NEXT_LINKAGE_OPERATOR_ENTRY (word_ptr)))
  213.         {
  214.           if (next_ptr > ((char *) scan_buffer_top))
  215.           {
  216.         extend_scan_buffer (next_ptr, To);
  217.         relocate_linked_operator (false);
  218.         next_ptr = (end_scan_buffer_extension (next_ptr));
  219.         overflow -= gc_buffer_size;
  220.           }
  221.           else
  222.         relocate_linked_operator (false);
  223.         }
  224.         Scan = (scan_buffer_top + overflow);
  225.         BCH_END_OPERATOR_RELOCATION (Scan);
  226.         break;
  227.       }
  228.  
  229.       default:
  230.       {
  231.         gc_death (TERM_EXIT,
  232.               "purify: Unknown compiler linkage kind.",
  233.               Scan, Free);
  234.         /*NOTREACHED*/
  235.       }
  236.     }
  237.     break;
  238.       }
  239.  
  240.       case TC_MANIFEST_CLOSURE:
  241.       {
  242.     if (purify_mode == PURE_COPY)
  243.     {
  244.       gc_death (TERM_COMPILER_DEATH,
  245.             "purifyloop: manifest closure in pure area",
  246.             Scan, To);
  247.       /*NOTREACHED*/
  248.     }
  249.       }
  250.       {
  251.     fast long count;
  252.     fast char * word_ptr;
  253.     char * end_ptr;
  254.  
  255.     Scan += 1;
  256.  
  257.     /* Is there enough space to read the count? */
  258.  
  259.     end_ptr = (((char *) Scan) + (2 * (sizeof (format_word))));
  260.     if (end_ptr > ((char *) scan_buffer_top))
  261.     {
  262.       long dw;
  263.  
  264.       extend_scan_buffer (end_ptr, To);
  265.       BCH_START_CLOSURE_RELOCATION (Scan - 1);
  266.       count = (MANIFEST_CLOSURE_COUNT (Scan));
  267.       word_ptr = (FIRST_MANIFEST_CLOSURE_ENTRY (Scan));
  268.       dw = (word_ptr - end_ptr);
  269.       end_ptr = (end_scan_buffer_extension (end_ptr));
  270.       word_ptr = (end_ptr + dw);
  271.       Scan = ((SCHEME_OBJECT *) (end_ptr - (2 * (sizeof (format_word)))));
  272.     }
  273.     else
  274.     {
  275.       BCH_START_CLOSURE_RELOCATION (Scan - 1);
  276.       count = (MANIFEST_CLOSURE_COUNT (Scan));
  277.       word_ptr = (FIRST_MANIFEST_CLOSURE_ENTRY (Scan));
  278.     }
  279.     end_ptr = ((char *) (MANIFEST_CLOSURE_END (Scan, count)));
  280.  
  281.     for ( ; ((--count) >= 0);
  282.          (word_ptr = (NEXT_MANIFEST_CLOSURE_ENTRY (word_ptr))))
  283.     {
  284.       if ((CLOSURE_ENTRY_END (word_ptr)) > ((char *) scan_buffer_top))
  285.       {
  286.         char * entry_end;
  287.         long de, dw;
  288.  
  289.         entry_end = (CLOSURE_ENTRY_END (word_ptr));
  290.         de = (end_ptr - entry_end);
  291.         dw = (entry_end - word_ptr);
  292.         extend_scan_buffer (entry_end, To);
  293.         relocate_manifest_closure (false);
  294.         entry_end = (end_scan_buffer_extension (entry_end));
  295.         word_ptr = (entry_end - dw);
  296.         end_ptr = (entry_end + de);
  297.       }
  298.       else
  299.         relocate_manifest_closure (false);
  300.     }
  301.     Scan = ((SCHEME_OBJECT *) (end_ptr));
  302.     BCH_END_CLOSURE_RELOCATION (Scan);
  303.     break;
  304.       }
  305.  
  306.       case_Cell:
  307.     relocate_normal_pointer (copy_cell(), 1);
  308.  
  309.       case TC_REFERENCE_TRAP:
  310.     if ((OBJECT_DATUM (Temp)) <= TRAP_MAX_IMMEDIATE)
  311.       break; /* It is a non pointer. */
  312.     goto purify_pair;
  313.  
  314.       case TC_INTERNED_SYMBOL:
  315.       case TC_UNINTERNED_SYMBOL:
  316.     if (purify_mode == PURE_COPY)
  317.     {
  318.       Temp = (MEMORY_REF (Temp, SYMBOL_NAME));
  319.       relocate_indirect_setup ();
  320.       copy_vector (NULL);
  321.       relocate_indirect_end ();
  322.     }
  323.     /* Fall through. */
  324.  
  325.       case_Fasdump_Pair:
  326.       purify_pair:
  327.     relocate_normal_pointer (copy_pair(), 2);
  328.  
  329.       case TC_WEAK_CONS:
  330.     if (purify_mode == PURE_COPY)
  331.       break;
  332.     else
  333.       relocate_normal_pointer (copy_weak_pair(), 2);
  334.  
  335.       case TC_VARIABLE:
  336.       case_Triple:
  337.     relocate_normal_pointer (copy_triple(), 3);
  338.  
  339.       case_Quadruple:
  340.     relocate_normal_pointer (copy_quadruple(), 4);
  341.  
  342.       case TC_BIG_FLONUM:
  343.     relocate_flonum_setup ();
  344.     goto Move_Vector;
  345.  
  346.       case TC_COMPILED_CODE_BLOCK:
  347.       case TC_ENVIRONMENT:
  348.     if (purify_mode == PURE_COPY)
  349.       break;
  350.     /* Fall through */
  351.  
  352.       case_Purify_Vector:
  353.     relocate_normal_setup ();
  354.       Move_Vector:
  355.     copy_vector (NULL);
  356.     relocate_normal_end ();
  357.  
  358.       case TC_FUTURE:
  359.     relocate_normal_setup();
  360.     if (!(Future_Spliceable (Temp)))
  361.       goto Move_Vector;
  362.     *Scan = (Future_Value (Temp));
  363.     Scan -= 1;
  364.     continue;
  365.  
  366.       default:
  367.     GC_BAD_TYPE ("purifyloop");
  368.     /* Fall Through */
  369.  
  370.       case_Non_Pointer:
  371.     break;
  372.  
  373.       }
  374.   }
  375. end_purifyloop:
  376.   *To_ptr = To;
  377.   *To_Address_ptr = To_Address;
  378.   return (Scan);
  379. }
  380.  
  381. /* This is not paranoia!
  382.    The two words in the header may overflow the free buffer.
  383.  */
  384.  
  385. static SCHEME_OBJECT *
  386. DEFUN (purify_header_overflow, (free_buffer), SCHEME_OBJECT *free_buffer)
  387. {
  388.   SCHEME_OBJECT *scan_buffer;
  389.   long delta;
  390.  
  391.   delta = (free_buffer - free_buffer_top);
  392.   free_buffer = (dump_and_reset_free_buffer (delta, NULL));
  393.   scan_buffer = (dump_and_reload_scan_buffer (0, NULL));
  394.   if ((scan_buffer + delta) != free_buffer)
  395.   {
  396.     gc_death (TERM_EXIT,
  397.           "purify: scan and free do not meet at the end",
  398.           (scan_buffer + delta), free_buffer);
  399.     /*NOTREACHED*/
  400.   }
  401.   return (free_buffer);
  402. }
  403.  
  404. static SCHEME_OBJECT
  405. DEFUN (purify, (object, flag),
  406.        SCHEME_OBJECT object AND SCHEME_OBJECT flag)
  407. {
  408.   long length, pure_length, delta;
  409.   SCHEME_OBJECT
  410.     * result, * free_buffer_ptr,
  411.     * old_free, * block_start,
  412.     * scan_start, * new_free;
  413.  
  414.   initialize_weak_pair_transport (Constant_Top);
  415.   free_buffer_ptr = (initialize_free_buffer ());
  416.   old_free = Free_Constant;
  417.   new_free = old_free;
  418.   block_start = ((SCHEME_OBJECT *) (ALIGN_DOWN_TO_IO_PAGE (old_free)));
  419.   delta = (old_free - block_start);
  420.   if (delta != 0)
  421.   {
  422.     fast SCHEME_OBJECT *ptr, *ptrend;
  423.  
  424.     for (ptr = block_start, ptrend = old_free; ptr != ptrend; )
  425.       *free_buffer_ptr++ = *ptr++;
  426.   }
  427.  
  428.   new_free += 2;
  429.   *free_buffer_ptr++ = SHARP_F;    /* Pure block header. */
  430.   *free_buffer_ptr++ = object;
  431.   if (free_buffer_ptr >= free_buffer_top)
  432.     free_buffer_ptr =
  433.       (dump_and_reset_free_buffer ((free_buffer_ptr - free_buffer_top), NULL));
  434.  
  435.   if (flag == SHARP_T)
  436.   {
  437.     scan_start = ((initialize_scan_buffer (block_start)) + delta);
  438.     result = (purifyloop (scan_start, &free_buffer_ptr,
  439.               &new_free, PURE_COPY));
  440.     if (result != free_buffer_ptr)
  441.     {
  442.       gc_death (TERM_BROKEN_HEART,
  443.         "purify: pure copy ended too early",
  444.         result, free_buffer_ptr);
  445.       /*NOTREACHED*/
  446.     }
  447.     pure_length = ((new_free - old_free) + 1);
  448.   }
  449.   else
  450.     pure_length = 3;
  451.  
  452.   new_free += 2;
  453.   *free_buffer_ptr++ = (MAKE_OBJECT (TC_MANIFEST_SPECIAL_NM_VECTOR, 1));
  454.   *free_buffer_ptr++ = (MAKE_OBJECT (CONSTANT_PART, pure_length));
  455.   if (free_buffer_ptr >= free_buffer_top)
  456.     free_buffer_ptr = (purify_header_overflow (free_buffer_ptr));
  457.  
  458.   scan_start = ((initialize_scan_buffer (block_start)) + delta);
  459.   if (flag == SHARP_T)
  460.     result = (purifyloop (scan_start, &free_buffer_ptr,
  461.               &new_free, CONSTANT_COPY));
  462.   else
  463.     result = (GCLoop (scan_start, &free_buffer_ptr, &new_free));
  464.  
  465.   if (result != free_buffer_ptr)
  466.   {
  467.     gc_death (TERM_BROKEN_HEART, "purify: constant copy ended too early",
  468.           result, free_buffer_ptr);
  469.     /*NOTREACHED*/
  470.   }
  471.  
  472.   new_free += 2;
  473.   length = (new_free - old_free);
  474.   *free_buffer_ptr++ = (MAKE_OBJECT (TC_MANIFEST_SPECIAL_NM_VECTOR, 1));
  475.   *free_buffer_ptr++ = (MAKE_OBJECT (END_OF_BLOCK, (length - 1)));
  476.   if (free_buffer_ptr >= free_buffer_top)
  477.     free_buffer_ptr = (purify_header_overflow (free_buffer_ptr));
  478.   end_transport (NULL);
  479.  
  480.   if (!(TEST_CONSTANT_TOP (new_free)))
  481.   {
  482.     gc_death (TERM_NO_SPACE, "purify: object too large", NULL, NULL);
  483.     /*NOTREACHED*/
  484.   }
  485.  
  486.   final_reload (block_start,
  487.         (new_free - block_start),
  488.         "the new constant space block");
  489.  
  490.   *old_free++ = (MAKE_OBJECT (TC_MANIFEST_SPECIAL_NM_VECTOR, pure_length));
  491.   *old_free = (MAKE_OBJECT (PURE_PART, (length - 1)));
  492.   Free_Constant = new_free;
  493.   SET_CONSTANT_TOP ();
  494.  
  495.   GC (1);
  496.   return (SHARP_T);
  497. }
  498.  
  499. /* Stub.  Not needed by this version.  Terminates Scheme if invoked. */
  500.  
  501. SCHEME_OBJECT
  502. DEFUN (Purify_Pass_2, (info), SCHEME_OBJECT info)
  503. {
  504.   gc_death (TERM_EXIT, "Purify_Pass_2 invoked", NULL, NULL);
  505.   /*NOTREACHED*/
  506. }
  507.  
  508. /* (PRIMITIVE-PURIFY OBJECT PURE? SAFETY-MARGIN)
  509.  
  510.    Copy an object from the heap into constant space.  It should only
  511.    be used through the wrapper provided in the Scheme runtime system.
  512.  
  513.    To purify an object we just copy it into Pure Space in two
  514.    parts with the appropriate headers and footers.  The actual
  515.    copying is done by PurifyLoop above.
  516.  
  517.    Once the copy is complete we run a full GC which handles the
  518.    broken hearts which now point into pure space.
  519.  
  520.    This primitive does not return normally.  It always escapes into
  521.    the interpreter because some of its cached registers (eg. History)
  522.    have changed.  */
  523.  
  524. DEFINE_PRIMITIVE ("PRIMITIVE-PURIFY", Prim_primitive_purify, 3, 3, 0)
  525. {
  526.   SCHEME_OBJECT object, daemon;
  527.   SCHEME_OBJECT result;
  528.   PRIMITIVE_HEADER (3);
  529.   PRIMITIVE_CANONICALIZE_CONTEXT ();
  530.  
  531.   STACK_SANITY_CHECK ("PURIFY");
  532.   Save_Time_Zone (Zone_Purify);
  533.   TOUCH_IN_PRIMITIVE ((ARG_REF (1)), object);
  534.   CHECK_ARG (2, BOOLEAN_P);
  535.   GC_Reserve = (arg_nonnegative_integer (3));
  536.  
  537.   ENTER_CRITICAL_SECTION ("purify");
  538.   {
  539.     SCHEME_OBJECT purify_result;
  540.     SCHEME_OBJECT words_free;
  541.  
  542.     purify_result = (purify (object, (ARG_REF (2))));
  543.     words_free = (LONG_TO_UNSIGNED_FIXNUM (MemTop - Free));
  544.     result = (MAKE_POINTER_OBJECT (TC_LIST, Free));
  545.     (*Free++) = purify_result;
  546.     (*Free++) = words_free;
  547.   }
  548.   POP_PRIMITIVE_FRAME (3);
  549.   daemon = (Get_Fixed_Obj_Slot (GC_Daemon));
  550.   if (daemon == SHARP_F)
  551.   {
  552.     Val = result;
  553.     EXIT_CRITICAL_SECTION ({});
  554.     PRIMITIVE_ABORT (PRIM_POP_RETURN);
  555.     /*NOTREACHED*/
  556.   }
  557.  
  558.   RENAME_CRITICAL_SECTION ("purify daemon");
  559.  Will_Push (CONTINUATION_SIZE + (STACK_ENV_EXTRA_SLOTS + 1));
  560.   Store_Expression (result);
  561.   Store_Return (RC_NORMAL_GC_DONE);
  562.   Save_Cont ();
  563.   STACK_PUSH (daemon);
  564.   STACK_PUSH (STACK_FRAME_HEADER);
  565.  Pushed ();
  566.   PRIMITIVE_ABORT(PRIM_APPLY);
  567.   /*NOTREACHED*/
  568. }
  569.